/*
 * Package il.ac.biu.cs.grossmm.api.data
 * File Converter.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package il.ac.biu.cs.grossmm.api.flow;

import il.ac.biu.cs.grossmm.api.OperationFailedException;

/**
 * Receives notifications about modifications in a source data node and applies
 * these modifications to a destination data node of a different type
 * 
 * @param <Nsrc>
 *            source node type
 * @param <Ndst>
 *            destination node type
 */
public interface ConverterProxy<Nsrc, Ndst> {
	/**
	 * Given a notification about modifications in the source data node applies
	 * these modifications to the destination data
	 * 
	 * @param srcInspector
	 *            data inspector for the source node
	 * @param dstManipulator
	 *            data manipulator for the destination node
	 * @throws OperationFailedException
	 */
	void convert(NodeEventInspector srcInspector, NodeManipulator dstManipulator)
		throws OperationFailedException;

	/**
	 * Called when this object is unused
	 * 
	 */
	void release();
}
